Civica Paylink - ebs Help

Civica Paylink is a third party supplier which is integrated with ebs to process online payments. You must contact Civica Paylink to agree a contract.

When you have negotiated a contract with Civica Paylink, you are ready to start the configuration with ebs. At this point you should have received a URL from Civica Paylink that is specific to your organisation.

Configuration

You must configure ePayments before configuring the payment provider.

The institution settings for Civica Paylink are configured on the following screens (accessed from the Product Modules pane):

ePayments (Self-Service)

ePayments (Self-Service) settings
This field	Holds this information...
ePayment provider	The electronic payment provider being used for ebs: ontrack Learner Hub. Select Civica Paylink from the drop-down list.
ePayment URL	The URL provided by Civica Paylink. This field must include the URL of your payment provider.
Network User ID	The network user ID. The value (maximum 30 characters) entered in this field is transmitted for Civica Paylink.
Only use default account code for payments	It is recommended this field is set to N for Civica Paylink.
Payment Merchant Reference	The account reference for Civica Paylink.
Default Account Code	The account code required by Civica Paylink if the fee type and the fee value are not specified. If the account code is used for all payments, then this value can be set accordingly. If different account codes are required for different fee types, leave this setting blank and specify values for the fee types/values.
Default Payment Email Address	The email address to which transaction emails are sent.
Generate single fee line, use default account code and VAT code only (SCP Only)	It is recommended this field is set to N for Civica Paylink.
Payment Account Fund Code	The account fund code for Civica Paylink.
Only use default VAT code for payments	Whether to use the VAT code set in the Default VAT Code institution setting for Civica Paylink. If this is set to N, the fee values/fee types are used to provide the VAT code. If neither of these are set, then the VAT code set in the Default VAT Code institution setting is used.
Default VAT code	The default VAT code to use for Civica Paylink.
ePayment failure message (Prospect)	The message displayed to learners in ebs: ontrack Learner Hub when payment fails in the institution's payment provider.

ePayments (Staff)

ePayments (Staff) settings
This field	Holds this information...
ePayment provider	The electronic payment provider being used for ebs: central. Select Civica Paylink from the drop-down list.
ePayment URL	The URL provided by Civica Paylink. This field must include the URL of your payment provider.
Network User ID Prefix	The Network User ID prefix. The value entered is a prefix added to the member of staff's username for Civica Paylink (for example: if the institution setting (maximum 20 characters) contains 'TRIBAL\' then TRIBAL\<user.name> is transmitted). If this setting is blank, the member of staff's username is transmitted without the prefix.
Payment Account ID	The Civica Paylink account ID. It is recommended this field is left blank for Civica Paylink.
Only use default account code for payments	It is recommended this field is set to N for Civica Paylink.
Payment Merchant Reference	The account reference for Civica Paylink.
Default Account Code	The account code required by Civica Paylink if the fee type and the fee value are not specified. If the account code is used for all payments, then this value can be set accordingly. If different account codes are required for different fee types, leave this setting blank and specify values for the fee types/values.
Default Payment Email Address	The email address to which transaction emails are sent.
Generate single fee line, use default account code and VAT code only (SCP Only)	It is recommended this field is set to N for Civica Paylink.
Payment Account Fund Code	The account fund code for Civica Paylink.
Only use default VAT code for payments	Whether to use the VAT code set in the Default VAT Code institution setting for Civica Paylink. If this is set to N, the fee values/fee types are used to provide the VAT code. If neither of these are set, then the VAT code set in the Default VAT Code institution setting is used.
Default VAT code	The default VAT code to use for Civica Paylink.
The Method of Transfer That ebs: central Uses For ePayments	The method of transfer that ebs uses for ePayments.

The following configuration information for Civica Paylink is also applicable:

Use the Microsoft Edge browser in Internet Explorer 11 compatibility mode for Civica

Default browser screen settings
This field	Holds this information...
Let Internet Explorer open sites in Microsoft edge	Whether to let Internet Explorer open sites in Microsoft edge. Set to 'Incompatibility sites only (recommended)'.
Allow sites to be checked in internet Explorer mode	Whether to allow sites to be checked in internet Explorer mode. Set to 'Allow'.
Internet explorer mode pages	The Civica URL. Click the ADD button. The Add a page window is displayed. Enter the Civica URL. Click Add.

Data Sent to Civica

The data sent to Civica when making a payment is described in the table Data sent to Civica.

Data sent to Civica
Value	Source	Notes
CallingApplicationId	Payment Merchant Reference	As defined in institution settings
CallingApplicationTransactionReference	The ePayment transaction ID	Generated from the EPAYMENT_TRANSACTION_ID_SEQ DB sequence when creating the payment
PaymentTotal	The total amount being paid	None
PaymentSourceCode	02 for client payments, 01 for others	This is determined by the source of the payment
hash	A hash to avoid tampering with the payment details	Hashed from the epayment transaction id and payment amount
ReturnURL	The URL used to report back the status of the payment	This is the server path appended by /epayments/PaymentResponse.aspx?pid={payment_token}

The data also sent per fee being paid for is described in the table Data sent per fee to Civica.

Data sent per fee to Civica
Value	Source	Notes
reference	Fee.AccountCode, Fee.FeeTypeAccountCode, InstSettings.DefaultAccountCode	The first non-empty account code, falling back to the system default if required
fund	Payment Account Fund Code	As defined in institution settings
matchedAmount	Fee.ReceiptAmount	None
vatCode	Empty String	Currently not implemented and sent through as an empty string
narrative	Fee.Description	None
businessName	Empty String	Currently not implemented and sent through as an empty string
premiseNumber	Empty String	Currently not implemented and sent through as an empty string
premiseName	Address Line 1 from Payment Details	None
street	Address Line 2 from Payment Details	None
area	Address Line 3 from Payment Details	None
town	Town from Payment Details	None
county	County from Payment Details	None
postcode	Postcode from Payment Details	None

Refer to PCI Compliance for further information about how ebs interacts with Civica Paylink.